Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guides: Update bincompat #367

Merged

Conversation

razvand
Copy link
Contributor

@razvand razvand commented Jan 7, 2024

Update binary compatibility guide to focus on application catalog, KraftKit-based runs, the base kernel image and the application registry.

@razvand razvand added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 7, 2024
@razvand razvand added this to the v0.17.0 (Calypso) milestone Jan 7, 2024
@razvand razvand marked this pull request as draft January 7, 2024 21:50
@razvand razvand force-pushed the razvand/guides/bincompat/update branch 7 times, most recently from 39ea7ce to 95be007 Compare January 26, 2024 17:35
@razvand razvand marked this pull request as ready for review January 26, 2024 17:35
@razvand razvand force-pushed the razvand/guides/bincompat/update branch 2 times, most recently from 7707676 to 1c7c5ed Compare January 27, 2024 12:28
@razvand razvand requested a review from paun75 January 27, 2024 16:09
Copy link

@paun75 paun75 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed-by: Daniel Paun [email protected]

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content looks good, but there are some rendering issues, see the comments.

content/docs/concepts/bincompat.mdx Outdated Show resolved Hide resolved
content/guides/catalog-add.mdx Outdated Show resolved Hide resolved
content/guides/catalog-firecracker.mdx Outdated Show resolved Hide resolved
content/guides/catalog-firecracker.mdx Outdated Show resolved Hide resolved
content/guides/catalog-internals.mdx Outdated Show resolved Hide resolved
content/guides/catalog-internals.mdx Outdated Show resolved Hide resolved
content/guides/catalog.mdx Outdated Show resolved Hide resolved
content/docs/concepts/bincompat.mdx Outdated Show resolved Hide resolved
content/guides/catalog.mdx Outdated Show resolved Hide resolved
Copy link
Member

@Mihnea0Firoiu Mihnea0Firoiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
Reviewed-by: Mihnea Firoiu [email protected]

@razvand razvand force-pushed the razvand/guides/bincompat/update branch from 1c7c5ed to 663dbbd Compare January 31, 2024 07:24
@razvand razvand requested a review from StefanJum January 31, 2024 07:24
Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good now, thanks.
Reviewed-by: Stefan Jumarea [email protected]

Update binary compatibility guide to focus on application `catalog`,
KraftKit-based runs, the `base` kernel image and the application
registry.

Signed-off-by: Razvan Deaconescu <[email protected]>
Split current guide on binary-compatibility. Move general introduction
to concepts section and reference the other sections.

Signed-off-by: Razvan Deaconescu <[email protected]>
Add guide center of users of the application catalog. Detail how
to use prebuilt applications in the registry and how to build and run
applications in the catalog repository.

Signed-off-by: Razvan Deaconescu <[email protected]>
Detail the internals of the build and run phases when using the catalog.
Present backing QEMU commands used for running.

Signed-off-by: Razvan Deaconescu <[email protected]>
Add guide on using Firecracker for catalog applications.

Signed-off-by: Razvan Deaconescu <[email protected]>
Add developer-centric guide to add new applications and examples to
the catalog. List steps to prepare recipe files (`Dockerfile`,
`Kraftfile`), documentation files and support files.

Signed-off-by: Razvan Deaconescu <[email protected]>
Reference bincompat guides in the bincompat concepts page.

Signed-off-by: Razvan Deaconescu <[email protected]>
@nderjung nderjung force-pushed the razvand/guides/bincompat/update branch 3 times, most recently from 0355a4c to 5cf732b Compare February 1, 2024 19:00
This commit refactors the recent guide entries on the Unikraft Community
Catalog of pre-built unikernel applications.  Specifically this change:

- Increases the slug length of guides, making URL sharing more friendly;
- Migrates the guide on contributing to the application catalog into the
  "Contributing" section of the website;
- Merges the pages of `bincompat.mdx` and `compatibility.mdx` since they
  represent the same information;
- Adjusts the MDX formatting of all code snippets for better
  readability.

Signed-off-by: Alexander Jung <[email protected]>
@nderjung nderjung force-pushed the razvand/guides/bincompat/update branch from 5cf732b to cbce3b8 Compare February 1, 2024 19:02
Copy link
Member

@nderjung nderjung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @razvand, this is very well written and put together, gg!

Reviewed-by: Alexander Jung [email protected]
Approved-by: Alexander Jung [email protected]

@nderjung nderjung merged commit c7d37ae into unikraft:main Feb 2, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

5 participants